Streams relate Class
Lets the user search for streams they can relate a given stream to, and relate it
Constructor
Streams relate
-
options
Parameters:
-
optionsObjectOverride various options for this tool
-
publisherIdStringpublisher id of the stream to relate
-
streamNameStringname of stream to relate
-
typesArraythe types of streams the user can select
-
relationTypeStringthe type of the relation to create
-
[communityId=Q.Users.communityId]String optionalid of the user publishing the streams to relate to
-
[typeNames]Object optionalpairs of {type: typeName} to override names of the types, which would otherwise be taken from the types
-
[multiple=true]Boolean optionalwhether the user can select multiple types for the lookup
-
[relateFrom=false]Boolean optionalif true, will relate FROM the user-selected stream TO the streamName instead
-
[types]String optionalthe types of streams the user can select
-
[onRelate]Q.Event optionalThis event handler occurs when a stream is successfully related
-
Item Index
Methods
Methods
refresh
-
An
Call this method to refresh the contents of the tool, requesting only what's needed and redrawing only what's needed.
Parameters:
-
AnFunctionoptional callback to call after refresh has completed. It receives (result, entering, exiting, updating) arguments.